Create a Warehouse Order (B2B)

Below is an example of the recommended information required for a warehouse order. This example is for a business customer who has ordered resupply of inventory for their retail operation.

Example Request

POST /warehouse/v1/orders HTTP/1.1
x-api-key: your_api_key
organization-slug: your_organization_slug (if required)
Content-Type: application/json

{
  "warehouseCode": "LAW",
  "primaryReference": "56784321",
  "secondaryReference": "PO100123",
  "shipToAddress": {
    "address": {
      "organization": "Target Store #100",
      "addressLine1": "123 Main Street",
      "addressLine2": "",
      "country": "USA",
      "state": "CA",
      "city": "Los Angeles",
      "postalCode": "90012"
    },
    "contact": {
      "personName": "Jane Doe",
      "phoneNumber": "111-222-3333",
      "mobileNumber": "",
      "faxNumber": "",
      "emailAddress": "jane.doe@target.com"
    }
  },
  "requiredShipDate": "2023-05-15T00:00:00+00:00",
  "orderLines": [
    {
      "externalLineReference": "001",
      "productCode": "LGT-K380-BT-KYBD",
      "quantity": 15,
      "quantityUnit": "UNT"
    },
    {
      "externalLineReference": "002",
      "productCode": "HP-SPX360-14-OLED-I7-16GB-1TB-NFBLK",
      "quantity": 22,
      "quantityUnit": "UNT"
    },
    {
      "externalLineReference": "003",
      "productCode": "SAM-GS22ULTRA-SILCASE-BLK",
      "quantity": 20,
      "quantityUnit": "UNT"
    }
  ],
  "additionalReferences": [
    {
      "key": "INV",
      "value": "INV100123"
    }
  ]
}

Replace your_api_key with your actual API key and your_organization_slug with your organization slug, if required.

Example Response

{
    "data": {
        "id": "680a65ba3e128e236fbe5071",
        "dateCreated": "2025-04-24T16:24:26+00:00",
        "dateLastUpdated": "2025-04-24T16:24:26+00:00",
        "status": "PRS",
        "warehouseCode": "LAW",
        "primaryReference": "56784321",
        "secondaryReference": "PO100123",
        "shipToAddress": {
            "address": {
                "organization": "Target Store #100",
                "addressLine1": "123 Main Street",
                "addressLine2": "",
                "country": "USA",
                "state": "CA",
                "city": "Los Angeles",
                "postalCode": "90012",
                "isResidential": false
            },
            "contact": {
                "personName": "Jane Doe",
                "phoneNumber": "111-222-3333",
                "mobileNumber": "",
                "faxNumber": "",
                "emailAddress": "jane.doe@target.com"
            }
        },
        "requiredShipDate": "2023-05-15T00:00:00+00:00",
        "jobCosting": {
            "branch": "CNO"
        },
        "packingRequired": false,
        "excludeFromTotePicking": false,
        "transportDetail": {},
        "orderLines": [
            {
                "lineNumber": "1",
                "externalLineReference": "001",
                "productCode": "LGT-K380-BT-KYBD",
                "quantity": 15,
                "quantityUnit": "UNT",
                "linePrice": 0,
                "lineAttributes": [],
                "lineCustomAttributes": [],
                "partAttributes": []
            },
            {
                "lineNumber": "2",
                "externalLineReference": "002",
                "productCode": "HP-SPX360-14-OLED-I7-16GB-1TB-NFBLK",
                "quantity": 22,
                "quantityUnit": "UNT",
                "linePrice": 0,
                "lineAttributes": [],
                "lineCustomAttributes": [],
                "partAttributes": []
            },
            {
                "lineNumber": "3",
                "externalLineReference": "003",
                "productCode": "SAM-GS22ULTRA-SILCASE-BLK",
                "quantity": 20,
                "quantityUnit": "UNT",
                "linePrice": 0,
                "lineAttributes": [],
                "lineCustomAttributes": [],
                "partAttributes": []
            }
        ],
        "forwardingData": {},
        "shipments": [
            {
                "id": "680a65ba3e128e236fbe5072",
                "status": "ENT",
                "dateCreated": "2025-04-24T16:24:26+00:00",
                "dateLastUpdated": "2025-04-24T16:24:26+00:00",
                "warehouseCode": "LAW",
                "primaryReference": "56784321",
                "secondaryReference": "PO100123",
                "shipToAddress": {
                    "address": {
                        "organization": "Target Store #100",
                        "addressLine1": "123 Main Street",
                        "addressLine2": "",
                        "country": "USA",
                        "state": "CA",
                        "city": "Los Angeles",
                        "postalCode": "90012",
                        "isResidential": false
                    },
                    "contact": {
                        "personName": "Jane Doe",
                        "phoneNumber": "111-222-3333",
                        "mobileNumber": "",
                        "faxNumber": "",
                        "emailAddress": "jane.doe@target.com"
                    }
                },
                "requiredShipDate": "2023-05-15T00:00:00+00:00",
                "transportDetail": {},
                "packages": [],
                "forwardingData": {},
                "packingRequired": false,
                "excludeFromTotePicking": false,
                "shipmentLines": [
                    {
                        "sublines": [],
                        "lineNumber": "1",
                        "externalLineReference": "001",
                        "productCode": "LGT-K380-BT-KYBD",
                        "quantity": 15,
                        "quantityUnit": "UNT",
                        "linePrice": 0,
                        "lineAttributes": [],
                        "lineCustomAttributes": [],
                        "partAttributes": []
                    },
                    {
                        "sublines": [],
                        "lineNumber": "2",
                        "externalLineReference": "002",
                        "productCode": "HP-SPX360-14-OLED-I7-16GB-1TB-NFBLK",
                        "quantity": 22,
                        "quantityUnit": "UNT",
                        "linePrice": 0,
                        "lineAttributes": [],
                        "lineCustomAttributes": [],
                        "partAttributes": []
                    },
                    {
                        "sublines": [],
                        "lineNumber": "3",
                        "externalLineReference": "003",
                        "productCode": "SAM-GS22ULTRA-SILCASE-BLK",
                        "quantity": 20,
                        "quantityUnit": "UNT",
                        "linePrice": 0,
                        "lineAttributes": [],
                        "lineCustomAttributes": [],
                        "partAttributes": []
                    }
                ],
                "milestones": [],
                "additionalReferences": [
                    {
                        "key": "INV",
                        "value": "INV100123"
                    }
                ],
                "priority": 0,
                "jobCosting": {
                    "branch": "CNO"
                }
            }
        ],
        "additionalReferences": [
            {
                "key": "INV",
                "value": "INV100123"
            }
        ],
        "priority": 0,
        "tags": [],
        "additionalNotes": []
    },
    "id": "cae91372-4936-46e7-b9b8-cda5d26e0fd7",
    "resource": [],
    "errors": []
}